QuickTestCheckPointConnection

SoftwareShield ClientProtector COM Component > ClientProtector (SSCProtector) Reference > QuickTestCheckPointConnection

## QuickTestCheckPointConnection

The QuickTestCheckPointConnection function performs a quick test on the CheckPoint server connection to determine if both communication is possible from the client machine and the CheckPoint server is up and responding to web-service requests.

###### Syntax

HRESULT QuickTestCheckPointConnection (

BSTR CheckPointURL,

VARIANT_BOOL UseProxyServer,

BSTR ProxyServerName,

long ProxyPort,

VARIANT_BOOL UseProxyAuthentication,

BSTR ProxyUserName,

BSTR ProxyPassword,

long * return_code

) ;

###### Parameters

CheckPointURL

[IN] This is a string value that must be set to the SOAP interface of the CheckPoint server you wish to test against. (See remarks below.)

UseProxyServer

[IN] This is a boolean value that you must set to true if the ClientProtector should use the proxy server information in communicating with the CheckPoint server, false otherwise.

ProxyServerName

[IN] This is a string value that you must set to the proxy server name (or IP) that the ClientProtector should use to locate the proxy server when performing CheckPoint communication. This value is ignored by the ClientProtector if UseProxyServer is false.

ProxyPort

[IN] This is a numeric value that you must set to the proxy server port number (usually 8080 but can be anything) that the ClientProtector should use to invoke the proxy server when performing CheckPoint communication. This value is ignored by the ClientProtector if UseProxyServer is false.

UseProxyAuthentication

[IN] This is a boolean value that you must set to true if the proxy server uses authentication (only "Basic Authentication" is supported). This value is ignored by the ClientProtector if UseProxyServer is false.

ProxyUserName

[IN] This is a string value that you must set to the users proxy server account name (used for authentication). This value is ignored by the ClientProtector if UseProxyServer or UseProxyAuthentication is false.

ProxyPassword

[IN] This is a string value that you must set to the users proxy server password (used for authentication). This value is ignored by the ClientProtector if UseProxyServer or UseProxyAuthentication is false.

return_code

[OUT] This is (a pointer to) a numeric value.

###### Remarks

Note: This function is illustrated in the SoftwareShield Flowcharts - (see flow chart #5).

The QuickTestCheckPointConnection function performs a quick test on the CheckPoint server connection to determine if both communication is possible from the client machine and the CheckPoint server is up and responding to web-service requests.

Unlike most other function in the ClientProtector interface - you may call this function before you call StartUp. It is completely independent from loading any license file. i.e.: You can create a new ClientProtector object and use it just for testing a CheckPoint connection using this function.

No matter where your CheckPoint License Server is deployed, the last portion of the CheckPointURL parameter should end with "checkpoint.dll/soap/ICheckPointService".

If the URL provided is empty, the return_code parameter will return holding FALSE_NO_CHECKPOINT_URL.

If the server cannot be contacted with the information provided, the return_code parameter will return holding FALSE_CONNECTION_FAILURE.

If the server is contacted successfully, the return_code parameter will return holding TRUE_CONNECTED.

About SSL (HTTPS) and Proxy Servers

Keep in mind that proxy servers generally can not act as a proxy for HTTPS (SSL) communication. HTTPS requires a secure handshake from point-to-point to enable its secure communications. A proxy server can not be in between the two participants (client and server) of an SSL communication. Most enterprises that use proxy servers allow direct outbound SSL communication for the workstations (default port 443) to allow SSL communication to work. If you are deploying your CheckPoint Server to be accessible via HTTPS only, be sure to take this into account when managing proxy server information.

###### Return Value

As with all COM function calls they return an HRESULT. HRESULT is a data type that is a 32-bit error or warning code. Check your compilers documentation for information on interpreting the HRESULT value.

###### Function Information

Exposed By Interface: | "ISSCProtector"
Exposed In COM Server Binaries: | "SSCProt.dll" and "SSCProtD.dll"